Authorizations
Generate a JWT access token through a Custom Global Integration and provide it with each request in the Authorization
header prefixed with "Bearer" and then a single space.
Path Parameters
Specify the delivery type to which your operations will be restricted.
asn
, rma
Query Parameters
Specify additional fields of the ASN
OR RMA
object to be included in the response.
See the selecting fields page for more information.
Specify additional fields of the Merchant
object to be included in the response. See the selecting fields page for more information.
Specify additional fields of the Brand
object to be included in the response. See the selecting fields page for more information.
Specify additional fields of the Brand
object to be included in the response. See the selecting fields page for more information.
Specify additional fields of the Warehouse
object to be included in the response. See the selecting fields page for more information.
Specify additional fields of the DeliveryStatusHistory
object to be included in the response. See the selecting fields page for more information.
Specify additional fields of the DeliveryTrackingNumber
object to be included in the response. See the selecting fields page for more information.
Using the filtering syntax, you may filter the results using the following fields:
id
name
state
status
The default sort order is descending by primary key (sort=-id
). The following fields are available for sorting:
id
label
If specified as 1
, the meta.count
property of the response will be present and populated with the total count of items
matching the query before any paging is applied. This is not included by default to improve performance in some edge
cases and is not required to perform paging using the next
property of the response.
See paging parameters for more information.
0 <= x <= 1
A cursor for use in pagination which defines the last id
of the next page of results, non-inclusive.
See paging parameters for more information on paging.
A cursor for use in pagination which defines the starting id
of the next page of results.
See paging parameters for more information on paging.
A limit on the number of objects to be returned.
1 <= x <= 1000
100
Response
A dictionary with a collection
property that contains an array of up to limit
RMA
OR ASN
objects. If no matching deliveries are found the array will be empty.
- ASN
- RMA
Lists of referenced objects included by specifying optional fields. See the selecting fields page for more information.
True if the collection has more items on the next page. Use the "next" link to retrieve the next page of results.
The resource path for the next page of results if any are expected.
The resource path for the previous page of results if any are expected.
Additional metadata pertaining to the response.